<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>usbpsu: Examples</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">usbpsu
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li class="current"><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('example.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">Examples </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>You can refer to the below stated example applications for more details which gives an idea of how the USB and its driver can be used for Bulk and Interrupt transfers.</p>
<h1><a class="anchor" id="ex1"></a>
xusb_ch9.c</h1>
<p>Contains the USB Chapter 9 specific code for the use of examples.</p>
<p>For details, see <a class="el" href="xusb__ch9_8c.html" title="This file contains the implementation of chapter 9 specific code for the example. ...">xusb_ch9.c</a></p>
<h1><a class="anchor" id="ex2"></a>
xusb_cp9.h</h1>
<p>This headerfile contains the constants, typedefs, variables and functions prototypes related to the USB Chapter 9 related code.</p>
<p>For details, see <a class="el" href="xusb__ch9_8h.html" title="This file contains definitions used chapter 9 specific code. ">xusb_ch9.h</a></p>
<h1><a class="anchor" id="ex3"></a>
xusb_ch9_storage.c</h1>
<p>This file contains the implementation of the Mass Storage Class specific chapter 9 functions.</p>
<p>For details, see <a class="el" href="xusb__ch9__storage_8c.html" title="This file contains the implementation of the Mass Storage specific chapter 9 code for the example...">xusb_ch9_storage.c</a></p>
<h1><a class="anchor" id="ex4"></a>
xusb_ch9_storage.h</h1>
<p>This headerfile contains the constants, typedefs, variables and functions prototypes related to the USB Mass Storage Class Chapter 9 related code.</p>
<p>For details, see <a class="el" href="xusb__ch9__storage_8h.html" title="This file contains definitions used in the Mass Storage specific chapter 9 code. ">xusb_ch9_storage.h</a></p>
<h1><a class="anchor" id="ex5"></a>
xusb_class_storage.c</h1>
<p>This file contains the Mass Storage Class specific functions.</p>
<p>For details, see <a class="el" href="xusb__class__storage_8c.html" title="This file contains the implementation of the Mass Storage specific class code for the example...">xusb_class_storage.c</a></p>
<h1><a class="anchor" id="ex6"></a>
xusb_class_storage.h</h1>
<p>This headerfile contains the constants, type definitions, variables and function prototypes used in the Mass Storage Class related code.</p>
<p>For details, see <a class="el" href="xusb__class__storage_8h.html" title="This file contains definitions used in the Mass Storage class code. ">xusb_class_storage.h</a></p>
<h1><a class="anchor" id="ex7"></a>
xusb_intr_example.c</h1>
<p>This example contains Mass Storage device application which provides a reference to create a new Bulk Transfer related application. For details, see <a class="el" href="xusb__intr__example_8c.html" title="This file implements DFU class example. ">xusb_intr_example.c</a></p>
<h1><a class="anchor" id="ex8"></a>
xusb_ch9_dfu.c</h1>
<p>This is the USB DFU example which contains USB DFU Class related Chapter 9 functions.</p>
<p>For details, see <a class="el" href="xusb__ch9__dfu_8c.html" title="This file contains the implementation of the DFU specific chapter 9 code for the example. ">xusb_ch9_dfu.c</a></p>
<h1><a class="anchor" id="ex9"></a>
xusb_ch9_dfu.h</h1>
<p>This headerfile contains the constants, type definitions, variables and function prototypes used in the USB DFU Class related Chapter 9 code.</p>
<p>For details, see <a class="el" href="xusb__ch9__dfu_8h.html" title="This file contains definitions used in DFU specific chapter 9 code. ">xusb_ch9_dfu.h</a></p>
<h1><a class="anchor" id="ex10"></a>
xusb_class_dfu.c</h1>
<p>This is the USB DFU example which contains USB DFU Class related functions.</p>
<p>For details, see <a class="el" href="xusb__class__dfu_8c.html" title="This file contains the implementation of the DFU specific class code for the example. ">xusb_class_dfu.c</a></p>
<h1><a class="anchor" id="ex11"></a>
xusb_class_dfu.h</h1>
<p>This headerfile contains the constants, type definitions, variables and function prototypes used in the USB DFU Class related code.</p>
<p>For details, see <a class="el" href="xusb__class__dfu_8h.html" title="This file contains definitions used in the DFU class code. ">xusb_class_dfu.h</a></p>
<h1><a class="anchor" id="ex12"></a>
xusb_dfu_example.c</h1>
<p>This example contains the DFU application code which demonstrates the usage of control transfers.</p>
<p>For details, see xusb_dfu_example.c</p>
<h1><a class="anchor" id="ex13"></a>
xusb_freertos_ch9_composite.c</h1>
<p>This file contains the usb chapter 9 related code which is used by freertos composite application.</p>
<p>For details, see <a class="el" href="xusb__freertos__ch9__composite_8c.html" title="This file contains the implementation of the composite device specific chapter 9 code for the example...">xusb_freertos_ch9_composite.c</a></p>
<h1><a class="anchor" id="ex14"></a>
xusb_freertos_ch9_composite.h</h1>
<p>This headerfile contains the constants, type definitions, variables and function prototypes related to Chapter 9 code used in the usb freertos composite gadget.</p>
<p>For details, see <a class="el" href="xusb__freertos__ch9__composite_8h.html" title="This file contains definitions used in composite device specific chapter 9 code. ">xusb_freertos_ch9_composite.h</a></p>
<h1><a class="anchor" id="ex15"></a>
xusb_freertos_class_composite.c</h1>
<p>This file contains the usb class specific code related to freertos composite gadget.</p>
<p>For details, see <a class="el" href="xusb__freertos__class__composite_8c.html" title="This file contains the implementation of the composite device specific class code for the example...">xusb_freertos_class_composite.c</a></p>
<h1><a class="anchor" id="ex16"></a>
xusb_freertos_class_composite.h</h1>
<p>This headerfile contains the constants, type definitions, variables and function prototypes related to usb class specific code used in the usb freertos composite gadget.</p>
<h1><a class="anchor" id="ex17"></a>
xusb_freertos_composite.c</h1>
<p>This example contains the code for demonstrating the freertos specific usb composite device application which has Mass Storage, HID, Audio and DFU class gadgets.</p>
<p>For details, see xusb_freertos_composite.c</p>
<h1><a class="anchor" id="ex18"></a>
xusb_ch9_composite.c</h1>
<p>This file contains the usb chapter 9 related code which is used by freertos composite application.</p>
<p>For details, see <a class="el" href="xusb__ch9__composite_8c.html" title="This file contains the implementation of the composite device specific chapter 9 code for the example...">xusb_ch9_composite.c</a></p>
<h1><a class="anchor" id="ex19"></a>
xusb_class_composite.h</h1>
<p>This headerfile contains the constants, type definitions, variables and function prototypes related to usb class specific code used in the usb composite gadget.</p>
<p>For details, see <a class="el" href="xusb__class__composite_8h.html" title="This file contains definitions used in the composite device class code. ">xusb_class_composite.h</a></p>
<h1><a class="anchor" id="ex20"></a>
xusb_composite_example.c</h1>
<p>This example contains the code for demonstrating the usb composite device application which has Mass Storage, HID, Audio and DFU class gadgets.</p>
<p>For details, see <a class="el" href="xusb__composite__example_8c.html" title="This file implements mass storage, hid, audio and dfu all in one composite device. ">xusb_composite_example.c</a></p>
<h1><a class="anchor" id="ex21"></a>
xusb_freertos_ch9_storage.c</h1>
<p>This file has the functions related to usb chapter 9 specific to freertos Mass Storage gadget example.</p>
<p>For details, see <a class="el" href="xusb__freertos__ch9__storage_8c.html" title="This file contains the implementation of the Mass Storage specific chapter 9 code for the example...">xusb_freertos_ch9_storage.c</a></p>
<h1><a class="anchor" id="ex22"></a>
xusb_freertos_ch9_storage.h</h1>
<p>This headerfile contains the constants, type definitions, variables and function prototypes related to usb chapter 9 specific code used in the freertos Mass Storage gadget example.</p>
<p>For details, see <a class="el" href="xusb__freertos__ch9__storage_8h.html" title="This file contains definitions used in the Mass Storage specific chapter 9 code. ">xusb_freertos_ch9_storage.h</a></p>
<h1><a class="anchor" id="ex23"></a>
xusb_freertos_class_storage.c</h1>
<p>This file has the functions related to usb class specific code used in freertos storage example.</p>
<p>For details, see xusb_freertos_class_storage.c</p>
<h1><a class="anchor" id="ex24"></a>
xusb_freertos_class_storage.h</h1>
<p>This headerfile contains the constants, type definitions, variables and function prototypes related to usb class specific code used in the freertos Mass Storage gadget example.</p>
<p>For details, see xusb_freertos_class_storage.h</p>
<h1><a class="anchor" id="ex25"></a>
xusb_freertos_massstorage.c</h1>
<p>This file contains the code for demonstrating the freertos specific Mass Storage usb gadget example.</p>
<p>For details, see xusb_freertos_massstorage.c</p>
<h1><a class="anchor" id="ex26"></a>
xusb_freertos_ch9_keyboard.h</h1>
<p>This file contains the usb chapter 9 code related to freertos specific Keyboard HID gadget application.</p>
<p>For details, see <a class="el" href="xusb__freertos__ch9__keyboard_8c.html" title="This file contains the implementation of the keyboard specific chapter 9 code for the example...">xusb_freertos_ch9_keyboard.c</a></p>
<h1><a class="anchor" id="ex26"></a>
xusb_freertos_ch9_keyboard.h</h1>
<p>This headerfile contains the constants, type definitions, variables and function prototypes related to usb chapter 9 specific code used in the freertos keyboard HID gadget example.</p>
<p>For details, see <a class="el" href="xusb__freertos__ch9__keyboard_8h.html" title="This file contains definitions used in the keyboard specific chapter 9 code. ">xusb_freertos_ch9_keyboard.h</a></p>
<h1><a class="anchor" id="ex27"></a>
xusb_freertos_class_keyboard.c</h1>
<p>This file contains the usb class code related to freertos specific keyboard HID gadget example.</p>
<p>For details, see <a class="el" href="xusb__freertos__class__keyboard_8c.html" title="This file contains the implementation of the HID specific class code for the example. ">xusb_freertos_class_keyboard.c</a></p>
<h1><a class="anchor" id="ex28"></a>
xusb_freertos_class_keyboard.h</h1>
<p>This headerfile contains the constants, type definitions, variables and function prototypes related to usb class specific code used in the freertos keyboard HID gadget example.</p>
<p>For details, see xusb_freertos_class_keyboard.h</p>
<h1><a class="anchor" id="ex29"></a>
xusb_freertos_keyboard.c</h1>
<p>This example contains the code for demonstrating freertos specific keyboard HID gadget.</p>
<p>For details, see xusb_freertos_keyboard.c</p>
<h1><a class="anchor" id="ex30"></a>
xusb_freertos_ch9_audio.c</h1>
<p>This file contains the usb ch9 code related to freertos specific audio example.</p>
<p>For details, see <a class="el" href="xusb__freertos__ch9__audio_8c.html" title="This file contains the implementation of the audio specific chapter 9 code for the example...">xusb_freertos_ch9_audio.c</a></p>
<h1><a class="anchor" id="ex31"></a>
xusb_freertos_ch9_audio.h</h1>
<p>This headerfile contains the constants, type definitions, variables and function prototypes related to usb chapter 9 specific code used in the freertos Audio gadget example.</p>
<p>For details, see <a class="el" href="xusb__freertos__ch9__audio_8h.html" title="This file contains definitions used in the chapter 9 code. ">xusb_freertos_ch9_audio.h</a></p>
<h1><a class="anchor" id="ex32"></a>
xusb_freertos_class_audio.c</h1>
<p>This file contains the usb class code related to freertos specific Audio gadget example.</p>
<p>For details, see <a class="el" href="xusb__freertos__class__audio_8c.html" title="This file contains the implementation of the audio specific class code for the example. ">xusb_freertos_class_audio.c</a></p>
<h1><a class="anchor" id="ex33"></a>
xusb_freertos_class_audio.h</h1>
<p>This headerfile contains the constants, type definitions, variables and function prototypes related to usb class specific code used in the freertos Audio gadget example.</p>
<p>For details, see <a class="el" href="xusb__freertos__class__audio_8h.html" title="This file contains definitions used in the class code. ">xusb_freertos_class_audio.h</a></p>
<h1><a class="anchor" id="ex34"></a>
xusb_freertos_audio.c</h1>
<p>This example contains the code for demonstrating freertos specific usb Audio class gadget.</p>
<p>For details, see xusb_freertos_audio.c</p>
<h1><a class="anchor" id="ex35"></a>
xusb_freertos_dfu.c</h1>
<p>This example contains the code for demonstrating freertos specific usb DFU Class gadget.</p>
<p>For details, see xusb_freertos_dfu.c</p>
<h1><a class="anchor" id="ex36"></a>
xusb_audio_dfu_example.c</h1>
<p>This example contains the code for demonstrating Audio + DFU class composite gadget example.</p>
<p>For details, see <a class="el" href="xusb__audio__dfu__example_8c.html" title="This file implements AUDIO-DFU composite class example. ">xusb_audio_dfu_example.c</a></p>
<h1><a class="anchor" id="ex37"></a>
xusb_ch9_audio_dfu.c</h1>
<p>This file contains the usb chapter 9 code related to Audio + DFU class composite gadget.</p>
<p>For details, see <a class="el" href="xusb__ch9__audio__dfu_8c.html" title="This file contains the implementation of the AUDO-DFU composite device specific chapter 9 code for th...">xusb_ch9_audio_dfu.c</a></p>
<h1><a class="anchor" id="ex38"></a>
xusb_ch9_audio_dfu.h</h1>
<p>This headerfile contains the constants, type definitions, variables and function prototypes related to usb chapter 9 specific code used in the Audio + DFU class composite gadget example.</p>
<p>For details, see <a class="el" href="xusb__ch9__audio__dfu_8h.html" title="This file contains definitions used in AUDIO-DFU composite device specific chapter 9 code...">xusb_ch9_audio_dfu.h</a></p>
<h1><a class="anchor" id="ex39"></a>
xusb_class_audio_dfu.c</h1>
<p>This file contains the usb class code related to the Audio + DFU class composite gadget example.</p>
<p>For details, see <a class="el" href="xusb__class__audio__dfu_8c.html" title="This file contains the implementation of the AUDIO-DFU composite device specific class code for the e...">xusb_class_audio_dfu.c</a></p>
<h1><a class="anchor" id="ex40"></a>
xusb_class_audio_dfu.h</h1>
<p>This headerfile contains the constants, type definitions, variables and function prototypes related to usb class specific code used in the Audio + DFU class composite gadget example.</p>
<p>For details, see <a class="el" href="xusb__class__audio__dfu_8h.html" title="This file contains definitions used in the AUDIO-DFU composite class code. ">xusb_class_audio_dfu.h</a></p>
<h1><a class="anchor" id="ex41"></a>
xusb_wrapper.c</h1>
<p>This file contains the wrapper functions which are called by the applications for communicating with the usbpsu driver.</p>
<p>For details, see <a class="el" href="xusb__wrapper_8c.html" title="This file contains implementation of USBPSU Driver wrappers. ">xusb_wrapper.c</a></p>
<h1><a class="anchor" id="ex42"></a>
xusb_wrapper.h</h1>
<p>This headerfile contains the constants, type definitions, variables and function prototypes related to usb wrapper code used for communicating with the usbpsu driver.</p>
<p>For details, see <a class="el" href="xusb__wrapper_8h.html" title="This file contains declarations for USBPSU Driver wrappers. ">xusb_wrapper.h</a></p>
<h1><a class="anchor" id="ex43"></a>
xusb_poll_example.c</h1>
<p>This example demonstartes the usage of usb BULK and Control transfers using polled mode.</p>
<p>For details, see <a class="el" href="xusb__poll__example_8c.html" title="This file implements the mass storage class poll example. ">xusb_poll_example.c</a></p>
<h2><a class="anchor" id="Notes"></a>
Notes</h2>
<ul>
<li>These examples are independent from one another. All the examples should include the <a class="el" href="xusb__ch9_8c.html" title="This file contains the implementation of chapter 9 specific code for the example. ...">xusb_ch9.c</a>, <a class="el" href="xusb__ch9_8h.html" title="This file contains definitions used chapter 9 specific code. ">xusb_ch9.h</a>, <a class="el" href="xusb__wrapper_8c.html" title="This file contains implementation of USBPSU Driver wrappers. ">xusb_wrapper.c</a>, and <a class="el" href="xusb__wrapper_8h.html" title="This file contains declarations for USBPSU Driver wrappers. ">xusb_wrapper.h</a> files.</li>
<li>For Mass Storage example, storage disk will mounted on the host and user can use "dd" command or can create a file system to transfer the data on the mounted storage disk. </li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
